home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 2.iso / dist / fw_hylafax.idb / usr / freeware / catman / u_man / cat1 / faxqclean.Z / faxqclean
Text File  |  2002-07-08  |  4KB  |  81 lines
  1. FAXQCLEAN(${MANNUM1_8})              FAXQCLEAN(${MANNUM1_8})
  2.  
  3.  
  4.  
  5. NNAAMMEE
  6.        faxqclean - _H_y_l_a_F_A_X queue cleaner process
  7.  
  8. SSYYNNOOPPSSIISS
  9.        $${{SSBBIINN}}//ffaaxxqqcclleeaann [ _o_p_t_i_o_n_s ]
  10.  
  11. DDEESSCCRRIIPPTTIIOONN
  12.        _f_a_x_q_c_l_e_a_n  is  a     program that processes    completed _H_y_l_a_F_A_X
  13.        jobs and    expunges unreferenced document files.  This  pro
  14.        gram  is     intended  to be invoked by _c_r_o_n(${MANNUM1_8}) on
  15.        behalf of the super user    (i.e. root) one    or more     times    a
  16.        day.   For  example,  the following crontab entry might be
  17.        setup for root to run _f_a_x_q_c_l_e_a_n each hour.
  18.      0   *      *    *    *    ${SBIN}/faxqclean
  19.  
  20.        When _f_a_x_q_c_l_e_a_n is run it    scans the ddoonneeqq     subdirectory  in
  21.        the  _H_y_l_a_F_A_X  spooling area and process each job    according
  22.        to the ddoonneeoopp field specified in    the job    description file;
  23.        c.f.   _s_e_n_d_q(${MANNUM4_5}).   Jobs  that     are  marked  for
  24.        removal    are  purged  and  references  to  documents   are
  25.        removed.      Jobs    that  are  marked  for    archival  may  be
  26.        archived    depending on the options supplied on the  command
  27.        line.
  28.  
  29.        After scanning for completed jobs _f_a_x_q_c_l_e_a_n scans the ddooccqq
  30.        subdirectory and    builds up  a  table  of     document  files.
  31.        Files  that  are     not  referenced  by any job and that are
  32.        older than a specified threshold    are removed.
  33.  
  34. OOPPTTIIOONNSS
  35.        --aa     Enable    job archiving support.    _N_B_: _v_4_._0 _d_o_e_s _n_o_t
  36.          _i_n_c_l_u_d_e _s_u_p_p_o_r_t _f_o_r _j_o_b _a_r_c_h_i_v_i_n_g_.
  37.  
  38.        --jj _s_e_c_s     Set the job age threshold (in seconds)    that con
  39.          trols how long    jobs  may  reside  in  the  ddoonneeqq
  40.          directory  before  being  processed.  By default
  41.          this value is 15 minutes (15*60 = 900    seconds).
  42.  
  43.        --dd _s_e_c_s     Set the document age threshold    (in seconds) that
  44.          controls how long unreferenced    files may  reside
  45.          in  the ddooccqq directory    before being removed.  By
  46.          default this value is 1 hour (60*60 = 3600  sec
  47.          onds).
  48.  
  49.        --nn     Do  not carry out any work; just show what would
  50.          be done.  This    option is  useful  together  with
  51.          the --tt    option for debugging.
  52.  
  53.        --qq _d_i_r     The specified directory is treated as the spool
  54.          ing area.  The    default    spooling area,    _$_{_S_P_O_O_L_},
  55.          is defined at the time    the software is    built.
  56.  
  57.        --tt     Trace    in great detail    exactly    what _f_a_x_q_c_l_e_a_n is
  58.          doing.     Messages are sent to the  standard  out
  59.          put.
  60.  
  61.        --vv     Print messages    on the standard    output about jobs
  62.          removed or archived  and  about  document  files
  63.          removed.
  64.  
  65. FFIILLEESS
  66.        ${SPOOL}/doneq       directory to    scan for completed jobs
  67.        ${SPOOL}/docq       directory to    scan for unreferenced documents
  68.        ${SPOOL}/archive       directory where archived jobs are placed
  69.  
  70.        Consult    _h_y_l_a_f_a_x_-_s_e_r_v_e_r(${MANNUM4_5})  for a complete dis
  71.        cussion of the structure    and content of the spooling area.
  72.  
  73. SSEEEE AALLSSOO
  74.        _f_a_x_q(${MANNUM1_8}),        _h_y_l_a_f_a_x_-_s_e_r_v_e_r(${MANNUM4_5}),
  75.        _s_e_n_d_q(${MANNUM4_5}),  _d_o_n_e_q(${MANNUM4_5}),  _a_r_c_h_i_v_e(${MAN
  76.        NUM4_5}).
  77.  
  78.  
  79.  
  80.               March    14, 1996  FAXQCLEAN(${MANNUM1_8})
  81.